/*
 *  Copyright (C) 2011 glauco
 * 
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 * 
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 * 
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.balisunrise.swing.components.documents;

/**
 *
 * @author glauco
 */
public interface DocumentFilter {

    /**
     * Evento disparado antes de inserir um segmento de string ao documento.
     * 
     * @param actualValue Valor atual do documento.
     * @param offSet posição inicial para inserir o segmento de string.
     * @param adding segmento de string que será inserido no documento.
     *
     * @return Deve ser retornado o novo valor do segmento de string a ser
     * inserido no documento. Se retornar null, a operação de inserir
     * o segmento de string no documento será cancelada.
     */
    public String beforeInsert(String actualValue, int offSet, String adding);
}
